Skip to content

Add bundle install step to the getting started guide #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Add bundle install step to the getting started guide #250

wants to merge 2 commits into from

Conversation

@patrickbrown-dev
Copy link

@patrickbrown-dev patrickbrown-dev commented Aug 9, 2024

When I was following the guide I had to do this step manually, and those who are newer to the Ruby ecosystem might not know this command is required before the bundle exec hanami dev command.

I hope this is helpful! Happy to change as needed! (Or maybe I did something wrong?)

Best,
Pat

@patrickbrown-dev
Add bundle install step to the getting started guide
6f9d413 
When I was following the guide I had to do this step manually, and
those who are newer to the Ruby ecosystem might not know this
command is required before the `bundle exec hanami dev` command.

I hope this is helpful! Happy to change as needed! (Or maybe I did
something wrong?)

Best,
Pat
@cllns
Copy link
Member

cllns commented Aug 9, 2024

Great find @patrickbrown-dev! Can you do the same for the 2.0 and 2.2 guides so we get this useful change for all recent versions?

@patrickbrown-dev
Copy link
Author

patrickbrown-dev commented Aug 9, 2024

@cllns great idea! I'll update this PR!

@timriley
Copy link
Member

timriley commented Aug 11, 2024

Hi @patrickbrown-dev, thanks for this suggestion!

hanami new should already run bundle install for you, so if you have to do this again manually, then I would consider that a bug with hanami new rather than a documentation issue to be fixed.

To this end, could you please have a go making a new app now and telling me if it actually still requires you to bundle install before running bundle exec hanami dev? And if so, any details about the output of hanami new would be useful to know too. This way we can get to the root cause and keep the experience best for all users.

timriley
timriley requested changes Aug 11, 2024
View reviewed changes
Copy link
Member

@timriley timriley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No merge yet, since we'll wait to learn more from @patrickbrown-dev about how hanami new has been working for them.

@patrickbrown-dev
Copy link
Author

patrickbrown-dev commented Aug 14, 2024

@timriley sorry for the delay! I'll take a look into this tonight!

@parndt
Copy link

parndt commented Oct 19, 2025

I think we should close this because as of at least Hanami 2.2.1 I couldn't reproduce:

➜  ~ gem install hanami
Successfully installed hanami-2.2.1
Parsing documentation for hanami-2.2.1
Installing ri documentation for hanami-2.2.1
Done installing documentation for hanami after 0 seconds
1 gem installed
➜  ~ hanami new bookshelf
Created bookshelf/
-> Within bookshelf/
Created .gitignore
Created .env
Created README.md
Created Gemfile
Created Rakefile
Created Procfile.dev
Created config.ru
Created bin/dev
Created config/app.rb
Created config/settings.rb
Created config/routes.rb
Created config/puma.rb
Created lib/tasks/.keep
Created lib/bookshelf/types.rb
Created app/actions/.keep
Created app/action.rb
Created app/view.rb
Created app/views/helpers.rb
Created app/templates/layouts/app.html.erb
Created package.json
Created config/assets.js
Created app/assets/js/app.js
Created app/assets/css/app.css
Created app/assets/images/favicon.ico
Created app/db/relation.rb
Created app/relations/.keep
Created app/db/repo.rb
Created app/repos/.keep
Created app/db/struct.rb
Created app/structs/.keep
Created config/db/seeds.rb
Created config/db/migrate/.keep
Created db/.keep
Created app/operation.rb
Created public/404.html
Created public/500.html
Running bundle install...
Running npm install...
Running hanami install...
➜  ~ cd bookshelf 
➜  bookshelf bundle exec hanami dev
18:17:47 web.1    | started with pid 53404

But please do reopen if this is an issue for anyone else!

@parndt parndt closed this Oct 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timriley timriley timriley requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@patrickbrown-dev @cllns @timriley @parndt